14 Installing JVMD with Advanced Install Options

Meet the Prerequisites

1. Install a Management Agent on host-b (the remote host), and point it to the OMS running on a Managed Server present in the Enterprise Manager Cloud Control domain (EMGC_DOMAIN).

   For information about installing a Management Agent, see Oracle Enterprise Manager Cloud Control Basic Installation Guide.

2. Install WebLogic Server on host-b using the Enterprise Manager Software Only installation option.

   To install JVMD Engine on a remote host successfully, the remote WebLogic Server version and patch level should match with the Managed Servers present in the Enterprise Manager Cloud Control domain (EMGC_DOMAIN). To ensure that the versions and patch levels match, Oracle recommends that you install WebLogic Server by selecting the Software Only install option in the Enterprise Manager OUI install.

   For information about performing a software only install, see Oracle Enterprise Manager Cloud Control Basic Installation Guide.

   These WebLogic Server bits must be registered with the Enterprise Manager domain running on host-a, so that all the Managed Servers appear under the same WebLogic domain.

3. Configure a new Managed Server using the WebLogic Server Administration Console as follows:

   1. Log into the Enterprise Manager WebLogic Domain console (EMGC_DOMAIN) of host-a.

      The WebLogic Server Administration Console home page appears.

   2. In Weblogic Server Administration Console, from the Domain Structure section, select Environment and then click Servers.

   3. On the Create a New Server page, enter Server Name, Server Listen Address, and Server Listen Port.

      Note:

      Ensure that the Server Listen Address corresponds to the listen address of the remote host, and the Server Listen port is free on the remote host.

4. Configure a new machine using the WebLogic Server Administration Console as follows:

   1. Log into the Enterprise Manager WebLogic Domain console (EMGC_DOMAIN) of host-a.

      The WebLogic Server Administration Console home page appears.

   2. In Weblogic Server Administration Console, from the Domain Structure section, select Environment and click Machines.

   3. On the Create a New Machine page, to associate this machine with the node manager running on host-b, enter the Listen Address of the remote host, and the node manager port number which is 5556 by default.

      This node manager primarily controls the starting and stopping of a remote host.

   4. Click Finish to create the machine.

5. Select the newly created machine, then click on Servers to add the Managed Server you created to this machine. This step associates the machine with the nodemanager running on host-b.

6. To extend the WebLogic Domain, a template of the Enterprise Manager Cloud Control domain running on host-a is created using the following command:

   ./pack.sh -domain = $DOMAIN_HOME -template = <absolute_path_to_the_new_weblogic_template> - template_name="My WebLogic Domain" -managed={true}
   
   Where:
   
   $DOMAIN_HOME is the location of EMGC domain on host-a.
   
   <absolute_path_to_the_new_weblogic_template> is the location where you want to create the template.
   

7. Copy emgcdomain.jar from host-a (where the OMS is running) to host-b (remote host).

8. Run the following command to unpack emgcdomain.jar template on host-b:

   ./unpack.sh -domain = $DOMAIN_HOME -template= <absolute_path_to_domain_template_created>
   
   Where:
   
   $DOMAIN_HOME is the domain location of EMGC on host-b (remote host)
   
   <absolute_path_to_domain_template_created> is the location of the template on host-b where emgcdomain.jar template is present.
   

9. To enroll the WebLogic Domain with node manager, perform the following steps on host-b:

   1. Run the following command to update the node manager properties file so that it can start monitoring the remote host:

      $WEBLOGIC_HOME/common/bin/wlst.sh

      nmEnroll($DOMAIN_HOME)

   2. Start the Node Manager as follows:

      <$WEBLOGIC_HOME>server/bin/startNodeManager.sh

      Note:

      Ensure that you set the property in the nodemanager property file before starting the Node Manager. You can set the property in one of the following methods:

      • Manually edit the nodemanager.properties file to set the property startScriptEnabled=true.

      • Run the script setNMProps.sh as follows: $MIDDLEWARE_HOME/oracle_common/common/bin/setNMProps.sh

   3. Perform the following steps to modify startWebLogic.sh:

      1. Navigate to the following location:

         - On Unix : $DOMAIN_HOME/bin/startWebLogic.sh

         - On Windows : $DOMAIN_HOME/bin/startWebLogic.cmd

      2. Set maximum heap size (-Xmx) to 1 GB for 64 bit systems, and maximum permanent generation (-XX:MaxPermSize) to 768M for 64-bit systems, as follows:

         USER_MEM_ARGS="-Xms256m -Xmx1024m -XX:MaxPermSize=768m"

         Note: If the remote Managed Server is started using a Sun JVM, then you must add following memory options to USER_MEM_ARGS: XX:+UnlockDiagnosticVMOptions and XX:+UnsyncloadClass.

      3. Set maximum heap size to 1 GB for 32-bit systems, and maximum permanent generation to 512M for 32-bit systems, as follows:

         USER_MEM_ARGS="-Xms256m -Xmx1024m -XX:MaxPermSize=512m"

10. Perform the following steps on host-a, then start the newly created Managed Server as follows:

    1. Copy the emreposauthbean.jar located in $OMS_HOME/sysman/jlib, to <middleware_home>/wlserver_10.3/server/lib/mbeantypes. Where, $OMS_HOME is the location of the OMS server on host-a, and <middleware_home> is on host-b.

    2. Copy the emCoreCommon.jar from $WEBLOGIC_HOME/sysman/jlib on host-a to $WEBLOGIC_HOME/server/lib on host-b.

    3. Import SSL Certificate to Enterprise Manager Agent Trust store present on the host where Managed Server is running.

    4. Start the Managed Server from the WebLogic Server Administration Console to complete the WebLogic Server setup.

11. Perform the following steps to discover the new Managed Server running on host-b:

    1. In Cloud Control, from the Targets menu, select Middleware.

       On the Middleware page, from the list of WebLogic servers running, select the WebLogic domain where the new Managed Server is deployed (that is, EMGC_DOMAIN).

    2. On the Cloud Control Domain page, from the WebLogic Domain menu, select Refresh WebLogic Domain.

       The new Managed Server now gets registered in the Enterprise Manager Cloud Control domain.

12. Restart the Managed Server for all the changes to take effect.

Deploy JVMD Engine on the Remote Host

To deploy JVMD Engine on a remote host (that is, a host that does not have Oracle Management Service installed), follow these steps:

1. From the Setup menu, select Middleware Management, then select Application Performance Management.

2. On the Application Performance Management page, from the Add menu, select JVM Diagnostics Engine.

3. On the Deploy JVM Diagnostics Engine page, select Deploy on an existing managed server.

   For Managed server, select the Managed Server running on the remote host on which you want to deploy JVMD Engine. The drop-down list displays all the Managed Servers present in the Enterprise Manager WebLogic domain.

4. Specify values for Oracle WebLogic Administration Server Host Credentials, Oracle WebLogic Server Domain Credentials, and Oracle WebLogic Managed Server Host Credentials.

   Oracle WebLogic Administration Server Host Credentials are the host credentials for the host on which the WebLogic Administration Server (for the Enterprise Manager WebLogic domain) is deployed. Oracle WebLogic Domain Credentials are the credentials for the Administration Server of the Enterprise Manager WebLogic domain. Oracle WebLogic Managed Server Host Credentials are the host credentials for the host on which the WebLogic Managed Server is deployed (that is, the host credentials for the remote host).

5. Click Deploy to submit a deployment job to the Enterprise Manager job system.

   Note:

   When you click Deploy, you may receive a warning mentioning that the WebLogic domain is already in edit mode, and mentioning the number of unsaved changes and non active changes. If there are no unsaved or non active changes, or if you are sure that the changes will not affect the JVMD Engine deployment, ignore this warning and proceed.

   The JVMD Engine Deployment Status page appears with a link to the job status. Click the link to view the status of the job that you submitted.

Download jvmd.zip

Before deploying JVMD Engine, ensure that you have downloaded jvmd.zip. To do so, in Enterprise Manager 12c, navigate to the following default location:

<MIDDLEWARE_HOME>/plugins/oracle.sysman.emas.oms.plugin_12.1.0.4.0/archives/jvmd.zip

You can download this file onto your local machine, and then run the following command to extract the contents of the zip file:

unzip jvmd.zip

The following is the output of this command:

Archive:  jvmd.zip
  inflating: jamagent.war 
  inflating: jammanager.ear    
  inflating: jammanager_dummy.ear  
 extracting: loadheap.zip      
  inflating: DeployJVMDEngine.cmd    
  inflating: DeployJVMDEngine.py   
  inflating: DeployJVMDEngine.sh     
   creating: customprov/
  inflating: customprov/DeployJVMDAgent.cmd  
  inflating: customprov/DeployJVMDAgent.py  
  inflating: customprov/DeployJVMDAgent.sh  
  inflating: customprov/deploy_jvmdagent.pl  
  inflating: customprov/README.txt   
  inflating: customprov/sample_jvmdagent_deploy.properties 
   creating: upgrade/
  inflating: upgrade/jvmd_monitoringupgrade11_12.sql  
  inflating: upgrade/jvmd_targetupgrade11_12.sql  
  inflating: upgrade/jvmd_traceupgrade11_12.sql  
  inflating: upgrade/README.txt      
 

The jvmd.zip file contains the following:

• DeployJVMDEngine.cmd: This script enables you to deploy JVMD Engine on a Windows host.

• DeployJVMDEngine.sh: This script enables you to deploy JVMD Engine on a Linux host.

• DeployJVMDEngine.py: This script is invoked by the DeployJVMDEngine.cmd and DeployJVMDEngine.sh scripts to deploy JVMD Engine.

• jamagent.war: JVMD Agent.

• jammanager_dummy.ear: A dummy JVMD Engine is deployed by the deployment scripts on the OMS. This JVMD Engine is deleted when JVMD Engine deployment is complete.

• jammanager.ear: JVMD Engine.

• loadheap.zip: This zip file contains the process log for each platform, and the scripts for loading the heap.

• customprov directory: The customprov directory contains the scripts used to deploy JVMD Agent from the command line, and is suitable for mass deployment.

• upgrade directory: The upgrade directory contains scripts for upgrade.

Deploy JVMD Engine

To deploy JVMD Engine from the command line, follow these steps:

1. Navigate to the following location, then transfer the jvmd.zip file here:

   <MIDDLEWARE_HOME>/oms/jvmd

2. Run the following command to extract the scripts from the jvmd.zip file:

   unzip jvmd.zip

3. Select the SSL port or the Non-SSL ports to be assigned to the Managed Server that will be created on the host where you want to deploy JVMD Engine.

   Note:

   To verify if the required ports are free, run the following command:

   netstat -a|grep <port_number>

4. Run the following script from the command line to deploy JVMD Engine:

   On Linux:

   ./DeployJVMDEngine.sh

   On Windows:

   DeployJVMDEngine.cmd

   The script updates the default values for many of the parameters. If you want to change any of the parameter values, you can provide them when prompted. If not, press Enter to select the default values.

   Note:

   A temporary file jammanager_dummy.ear is deployed on the OMS so that JVMD Engine can access the repository. This file is deleted once the deployment is complete.

   Once the deployment is successful, you will see the status as follows:

   Current Status of your Deployment:
   Deployment command type : deploy
   Deployment State        : completed
   Deployment Message      : no message
   

5. Once a connection to the repository is established, a server is created in the Enterprise Manager Cloud Control WebLogic domain on which JVMD Engine is deployed. By default, this server is called EMGC_JVMDMANAGER1. The displayed output is as follows:

   Starting server EMGC_JVMDMANAGER1
   Server with name EMGC_JVMDMANAGER1 started successfully
   

6. Refresh the Enterprise Manager Cloud Control domain.

   To do this, log in to the Enterprise Manager console. Navigate to the Enterprise Manager Cloud Control domain home page. From the Farm menu, select Refresh WebLogic Domain.

Download javadiagnosticagent.ear or jamagent.war

This section describes how to download the javadiagnosticagent.ear or jamagent.war file. It consists of the following:

• Downloading javadiagnosticagent.ear or jamagent.war Using Cloud Control

• Downloading jamagent.war Using javadiagnosticagent.ear

Downloading javadiagnosticagent.ear or jamagent.war Using Cloud Control

To download javadiagnosticagent.ear or jamagent.war using Cloud Control, follow these steps:

1. In Cloud Control, from the Setup menu, select Middleware Management, then select Application Performance Management.

2. On the Application Performance Management page, select JVM Diagnostics Engine.

3. Click Configure. The JVM Diagnostics Setup page appears.

4. On the JVM Diagnostics Setup page, click JVMs and Pools, then click Download. The Download JVM Diagnostics Component dialog box appears.

   
   

5. From the JVMD Component menu, to download javadiagnosticagent.ear, select JVMD Agent with MDA (Weblogic only), then click OK. To download jamagent.war, from the JVMD Component menu, select JVMD Agent, then click OK. The JVM Diagnostics Agent web.xml parameters dialog box appears.

   
   

6. From the Available Engines menu, select an option from the list, then click Download:

   • Select the HTTP URL if you want the JVMD Agent to connect to the JVMD Engine using a non-secure connection.

   • Select the HTTPS URL if you want the JVMD Agent to connect to the JVMD Engine using a secure connection.

   • Select Custom if you want the JVMD Agent to connect to a JVMD Engine through a load balancer. Specify the host name and the port that the JVMD Agent must connect to.

   For example:

   HTTP: http://slc01.us.example.com:3800

   HTTPS: https://slc01.us.example.com:3801 (secure communication)

   
   

7. Click Download to download javadiagnosticagent.ear or jamagent.war.

Downloading jamagent.war Using javadiagnosticagent.ear

To download jamagent.war using javadiagnosticagent.ear, follow these steps:

1. Download the javadiagnosticagent.ear file to the following location:

   <middleware_home>/oms/jvmd

   The javadiagnosticagent.ear file can be downloaded from the following location:

   <MIDDLEWARE_HOME>/plugins/oracle.sysman.emas.oms.plugin_12.1.0.4.0/archives/javadiagnosticagent.ear

2. Run the following command to extract the JVMD Agent script present in javadiagnosticagent.ear:

   jar -xvf javadiagnosticagent.ear

3. Navigate to WEB-INF/web.xml.

4. Edit the web.xml file to update the values of the jamconshost and jamconsport parameters, where jamconshost is the IP of the host on which JVMD Engine is deployed, and jamconsport is the port of the same host.

   Note:

   To enable secure communication for the selected JVMD Engine, make the following change to the web.xml file:

   jamsecureCommunication = 1

   For example:

   <init-param>
           <param-name>jamconshost</param-name>
           <param-value>slc01axn</param-value>
           <description>Jam console host - demolnx.auptyma.com</description>
    </init-param>
    <init-param>
           <param-name>jamconsport</param-name>
           <param-value>3800</param-value>
           <description>Jam console port</description>
    </init-param>
   

   Note:

   Once JVMD Engine is deployed, the IP and the port appear on the JVMD Deployment page as: <Machine Name:Port Number>

5. Run the following command to reassemble the jamagent.war file:

   jar -cMvf jamagent.war META-INF WEB-INF jamagent oracle

   The updated jamagent.war file is now ready for deployment.

Deploy JVMD Agent

This section describes how to deploy JVMD Agent on various application servers. It consists of the following:

• Deploying JVMD Agent on WebLogic Server

• Deploying JVMD Agent on Glassfish

• Deploying JVMD Agent on JBoss

• Deploying JVMD Agent on Tomcat

• Deploying JVMD Agent on Websphere

• Deploying JVMD Agent on OC4J

Deploying JVMD Agent on WebLogic Server

To deploy JVMD Agent on a Weblogic Managed Server manually, follow these steps:

1. Make a copy of the deployment profile sample_jvmdagent_deploy.properties available in the jvmd.zip file. Update the location of the javadiagnosticagent.ear file, the name of the WebLogic domain, and the server information. Save the profile as jvmdagent_deploy.properties.

   For more information about the parameters, view the README.txt file present in the customprov folder of the jvmd.zip file.

2. Run the following perl script available in the customprov folder of the jvmd.zip file to deploy JVMD Agent on all the specified servers.

   perl deploy_jvmdagent.pl

   Note:

   Ensure that the deployment profile jvmdagent_deploy.properties and the perl scripts are available in the same folder.

Deploying JVMD Agent on Glassfish

To deploy JVMD Agent on Glassfish manually, follow these steps:

1. Log in to the Glassfish Administration console.

2. In the Common Tasks section, click Applications.

3. In the Deployed Applications section, click Deploy.

4. For Location, select Packaged File to Be Uploaded to the Server, then specify the location on your local host where jamagent.war is present.

5. For Selected Targets, add the server on which you want to deploy jamagent.war.

6. Click OK.

Deploying JVMD Agent on JBoss

To deploy JVMD Agent on JBoss manually, follow these steps:

1. Log in to the JBoss Administration console.

2. Under Applications, click Web Application (WAR)s.

3. Click Add a new resource.

4. Enter the absolute path to jamagent.war present on your local host.

5. For both Deploy Exploded and Deploy Farmed, select No.

6. Click Continue.

To deploy JVMD Agent on JBoss manually, you can also do the following:

1. Transfer jamagent.war to the following location:

   <JBOSS_HOME>/server/all/deploy

2. Restart the application server.

Deploying JVMD Agent on Tomcat

To deploy JVMD Agent on Tomcat manually, follow these steps:

1. Transfer jamagent.war to the following location:

   $CATALINA_BASE/webapps

2. Restart the application server.

   For the latest versions of Tomcat, if the autoDeploy flag is set to true in $CATALINA_BASE/conf/server.xml, you do not need to restart the application server. Tomcat will pick up jamagent.war at runtime.

Deploying JVMD Agent on Websphere

To deploy JVMD Agent on Websphere manually, follow these steps:

1. Log in to the Websphere Administration console.

2. Expand Applications, then click New Application.

3. Click New Enterprise Application.

4. For Path to the new application, select Local file system, then specify the location on your local host where jamagent.war is present.

5. Provide the context root for jamagent.war.

6. Save the con figuration.

7. Start the application.

Deploying JVMD Agent on OC4J

To deploy JVMD Agent on OC4J manually, follow these steps:

1. Log in to the OC4J Administration console.

2. Click Applications.

3. Click Deploy.

4. Select Archive is present on local host. For Archive Location, specify the location on your local host where jamagent.war is present. Click Next.

5. For Application Name, enter jamagent. For Context Root, enter /jamagent.

6. Click Deploy.

Deploying JVMD Agent on a Standalone JVM

A JVMD Agent can be deployed on a standalone JVM such that the inputs are read from web.xml, or such that you specify the inputs on the command line.

To deploy a JVMD Agent on a standalone JVM such that all the inputs are read from web.xml, run the following command from the command line:

java -cp <absolute_path_to_jamagent.war> jamagent.jamrun <java_class_with_a_main_method>

To deploy a JVMD Agent on a standalone JVM by specifying all the inputs on the command line, run the following command from the command; line:

java -cp <absolute_path_to_jamagent.war> jamagent.jamrun <java_class_with_a_main_method> jamconshost=<jvmd_engine_host> jamconsport=<jvmd_engine_listen_port> jamjvmid=<unique_jvmd_identifier> jamtimeout=<timeout_period_in_seconds> jamloglevel=<jvmd_agent_log_level>

******can_tag_objects capability is not set.Copy library libjamcapability to another directory and restart Java with argument "-agentpath:<absolute_path_to_libjamcapability.so>" ******

Deploying JVMD Agents for High Availability Using the Application Performance Management Page

To deploy JVMD Agents for high availability using the Application Performance Management page, follow these steps:

1. Follow the steps mentioned in Oracle Enterprise Manager Cloud Control Basic Installation Guide to deploy a JVMD Agent.

2. On the JVMD Agents Configurations page, for Available JVMD Engines, select Other. Provide the load balancer host name and port.

   Click Next.

3. On the Review page, review all the information, then click Deploy.

Deploying JVMD Agents for High Availability Manually

To deploy JVMD Agents for high availability manually, follow these steps:

1. Follow the steps mentioned in Downloading javadiagnosticagent.ear or jamagent.war Using Cloud Control to download javadiagnosticagent.ear or jamagent.war.

2. When the JVM Diagnostics Agent web.xml parameters dialog box is displayed, from the Available Engines menu, select Custom. Provide the load balancer host name and port.

   Click Download.

3. Deploy the JVMD Agent as mentioned in Deploy JVMD Agent.